Platform Explorer / Nuxeo Platform 2021.56

Extension point actionPipes

In component org.nuxeo.ecm.platform.MailService

Documentation

Extension point to register a list of actions.

An ActionPipe is a list of ActionMessage used for mail import. Default contribution are merged but you can override them using 'override' attribute. 

        <pipe name="nxmail" override="true">
            <action id="StartAction" to="CreateDocumentsAction">
            org.nuxeo.ecm.platform.mail.listener.action.StartAction
          </action>
            <action id="CreateDocumentsAction">
            org.nuxeo.ecm.platform.mail.listener.action.CreateDocumentsAction
          </action>
        </pipe>

When registering the ActionPipe, the service looks for an ActionMessage named 'StartAction', so this is a mandatory attribute. Registration of the pipe ends when service doesn't find the next action.

Since 6.0, you can use Automation to control how Documents are created from email. For that you need to redefine the ActionPipe. 

        <pipe name="nxmail" override="true">
            <action>
            org.nuxeo.ecm.platform.mail.listener.action.StartAction
          </action>
            <action>
            org.nuxeo.ecm.platform.mail.listener.action.ExtractMessageInformationAction
          </action>
            <action chain="CreateMailDocumentFromAutomation">
            org.nuxeo.ecm.platform.mail.listener.action.CreateDocumentsFromAutomationChainAction
          </action>
        </pipe>

Then the CreateMailDocumentFromAutomation Chain whill be used to create the content.

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.mail.action.MessageActionPipeDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-platform-mail-2021.56.5.jar /OSGI-INF/nxmail-contrib.xml 
    <extension point="actionPipes" target="org.nuxeo.ecm.platform.MailService">

    <pipe name="nxmail">
      <action>
        org.nuxeo.ecm.platform.mail.listener.action.StartAction
      </action>
      <action>
        org.nuxeo.ecm.platform.mail.listener.action.ExtractMessageInformationAction
      </action>
      <action>
        org.nuxeo.ecm.platform.mail.listener.action.CheckMailUnicity
      </action>
      <action>
        org.nuxeo.ecm.platform.mail.listener.action.CreateDocumentsAction
      </action>
    </pipe>

  </extension>
    (0) nuxeo-platform-mail-2021.56.5.jar/OSGI-INF/nxmail-contrib.xml   Override